home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / boot / TheChoice2.lha / TheChoice.ReadMe < prev    next >
Encoding:
Text File  |  1996-09-09  |  12.0 KB  |  323 lines
  1. Short:        TheChoice V2.20 - Simple Program Selector
  2. Author:       c_wich@river.prima.ruhr.de (Carsten Wich)
  3. Uploader:     c_wich@river.prima.ruhr.de (Carsten Wich)
  4. Type:         util/boot
  5.  
  6.                              ===================
  7.                              = TheChoice V2.20 =
  8.                              ===================
  9.                              Release: 09.09.1996
  10.                               Copyright 1993-96
  11.                                      by
  12.                                 Carsten Wich
  13.                                Hagebuttenweg 34
  14.                                D-44289 Dortmund
  15.                                    Germany
  16.                             Phone: +49-2304-43692
  17.                       E-Mail: c_wich@river.prima.ruhr.de
  18.  
  19.                          Bank Account No. 315 1048 400
  20.                                 BLZ 441 600 14
  21.                               Volksbank Dortmund
  22.  
  23.  
  24. INTRODUCTION
  25. ============
  26.  
  27. The Choice is a small Program Selector especially useful for Game Partitions
  28. on Harddisks, SyQuests or even CD-ROMs.
  29. I first wrote it in Modula2 (M2Amiga) because I just found no simple program
  30. selector that fully suits my needs. Although the first version of it worked
  31. good enought for me, some of my friends liked the program very much and made
  32. some proposals for future versions. I switched to SAS-C because the support
  33. for M2Amiga is not that good anymore. Especially the lack of actual includes
  34. for OS3.1 really bothered me. I have completly rewritten the code in the C
  35. programming language and made a lot of improvements.
  36. TheChoice runs on every possible screenmode, even on graphic cards !
  37.  
  38.  
  39. LEAGAL THINKS
  40. =============
  41.  
  42. TheChoice Copyright (c) 1993-1996 Carsten Wich can be freely distributed,
  43. as long as the whole archive 'TheChoice2.lha' is copied and all of the
  44. files are in their original form without any changes.
  45. Upload to BBS's and includions on any cover disks or CD's is WELCOMED.
  46. This software is published without any warranties. The author does NOT take
  47. any responsibilities for any defects on soft- or hardware, that may result
  48. by this program or by using this program.
  49. I have tried to write the program code according to the AMIGA User Interface
  50. Style Guide and the AMIGA ROM Kernel Reference Manuals V2.04 so that the
  51. program should run correctly on any future operating systems. It is also
  52. tested with Enforcer.
  53. Although this program may be freely distibuted and used it would be very nice
  54. of the people who permanently use it to send me a small fee (I would say at
  55. 15,- DM or $10,- US) as a little acknowledgement for my work. You can send
  56. it cash, as a EuroCheque or via a Bank Transfer on my Bank Account.
  57. This would increase my motivation to develop the program even further.
  58.  
  59.  
  60. SYSTEMREQUIREMENTS
  61. ==================
  62.  
  63. The program only needs a minimal Amiga System :
  64.  
  65.   - Any Amiga with at least 512 KB RAM
  66.   - OS >= 2.04 (V37)
  67.   - diskfont.library min. V36 when you want to select another font than the
  68.     default one
  69.   - OS >= 3.0 (V39) for CLOSEQUIET option (optional)
  70.   - lowlevel.library >= V40 for Joystick support (optional)
  71.  
  72.  
  73. DEVELOPMENT ENVIRONMENT
  74. =======================
  75.  
  76. Hardware :
  77.  
  78.   - Amiga 2000C Big Tower with ECS Chipset (2MB Chip RAM)
  79.   - GForce 030 50MHz with 16MB 32Bit RAM
  80.   - GVP EGS 28/24 LC
  81.   - GVP I/O Extender
  82.   - NEC 3D
  83.   - Toshiba MK-537 1GB HD
  84.   - Toshiba XM-3401TA  CD-ROM
  85.   - HP-38470A DAT Streamer
  86.   - ZyXEL Elite 2864D
  87.  
  88. Software :
  89.  
  90.   - Kickstart V40.63 ROM
  91.   - Workbench V40.42
  92.   - CyberGraphX V2.18reg
  93.   - SAS-C V6.56
  94.   - GoldEd V4.1.3 reg.
  95.   - Enforcer / Mungwall / Sushi
  96.   - Diavolo Backup V3.2 (Yeah, the best backup program around)
  97.   - DOpus 5.11d
  98.  
  99.  
  100. HOW IT WORKS
  101. ============
  102.  
  103. TheChoice opens its window on the default public screen (or one that you
  104. specify) and displays an Intuition gadget for every program that you can
  105. choose from.
  106. The window which is opened by TheChoice always covers the whole screen, no
  107. matter how many script entries the config file has.
  108. If there are more script entries than the maximum number of gadgets the
  109. window can hold, TheChoice stops reading the config file and uses this
  110. maximum number of programs only. If you want to display more selections
  111. increase the resolution of the screen or decrease the size of the font.
  112. Future version will hopefully have the possibility to select different
  113. pages.
  114. The program to be executed can easily be selected by a left mouse click.
  115. That's all ! Nothing more and nothing less. (Sounds quite simple, eh ?) 8-)
  116. If you don't want to execute any program just activate the Close gadget or
  117. press the ESC key.
  118. From Version 2.20 on you can also select the gadget using a Joystick in the
  119. game port or the keyboard. A small blue border is drawn around the actual
  120. gadget which can be moved using the joystick or the cursor keys. With the
  121. fire button or the RETURN key you can select the actual program.
  122.  
  123.  
  124. INSTALLATION
  125. ============
  126.  
  127. Installation is quite simple. Just place TheChoice in a path of your choice
  128. and create a config file (normally called 'TheChoice.config' in the same
  129. path as the main program).
  130. You can of course use the one that came with the distribution archive and
  131. alter that one.
  132.  
  133.  
  134. CONFIGURATION
  135. =============
  136.  
  137. All configuration of TheChoice other than that for the programs to be
  138. executed is made through shell arguments or tooltypes. They both have the
  139. same syntax so I only have to describe them once. Entering "TheChoice ?"
  140. from CLI gives you the template for the shell options (and some abbrevia-
  141. tions for them).
  142.  
  143.   CONFIGFILE   : Here you can set the path and the name of the config file
  144.                  TheChoice should use.
  145.                  Defaults simply to 'TheChoice.config'.
  146.                  Note: You must not specify the keyword CONFIGFILE when
  147.                        starting TheChoice from shell.
  148.  
  149.   PUBSCREEN    : Here you can specify the name of an already open public
  150.                  screen on that TheChoice should open its window.
  151.                  Defaults to the default public screen (normally the Work-
  152.                  bench screen or the initial CLI startup screen).
  153.  
  154.   MODEID       : TheChoice tries to open its own screen when you set this
  155.                  option to a valid screenmode ID.
  156.  
  157.   FONTNAME &     
  158.   FONTHEIGHT   : Here you can specify the font TheChoice uses for the gadget
  159.                  texts. The font that is used for the window topborder is
  160.                  always the default font for that screen.
  161.                  You have to specify both options, e.g. FONTNAME=topaz.font
  162.                  and FONTHEIGHT=8.
  163.                  If not set TheChoice uses the screens default font for
  164.                  windows.
  165.  
  166.   ONEBITPLANE  : This option is only effective when you also set the MODEID
  167.                  option. When set TheChoice opens its own screen using only
  168.                  one bitplane. This is useful if you are short of memory.
  169.  
  170.  
  171.   BORDERLESS   : When you specify this option TheChoice opens it window in
  172.                  an borderless mode, so no borders are drawn by intuition
  173.                  around the window.
  174.  
  175.   CLOSEQUIET   : When specified this option changes the way TheChoice closes
  176.                  a screen it has opened by itself using a special routine,
  177.                  so that no Workbench screen is opened. Additionally all four
  178.                  colours are sets to black. Requires OS >= V39
  179.  
  180.   MAXGADLEN    : Here you can specify the maximum character length that can
  181.                  be used for the gadgets. This option has an effect on how
  182.                  many gadget can be put in a window.
  183.                  Defaults to 24.
  184.  
  185.   MAXSCRIPTLEN : With this option you can set the maximum length of the
  186.                  script name (!) that is associated with the program name.
  187.                  This option has an effect for the size of the memory that
  188.                  is used for storing these names.
  189.                  Defaults to 40.
  190.  
  191.   EXESCRIPT    : Normally TheChoice executes the script that is associated
  192.                  with the chosen program directly. That has the disadvantage
  193.                  that not all resources are freed before program execution.
  194.                  When you set this option TheChoice copies the name of the
  195.                  script that has to be executed in order to run the selected
  196.                  program in a file 'RAM:script'. This file has to be executed
  197.                  after TheChoice has terminated.
  198.                  Example startup script :
  199.  
  200.                    ...
  201.                    TheChoice
  202.                    Avail >NIL: Flush
  203.                    Execute RAM:script
  204.                    EndCli
  205.  
  206.                  Default is direct execution.
  207.  
  208.  
  209. CONFIG-FILE
  210. ===========
  211.  
  212. From Release 2.00 on the configfile can be located anywhere and can be named
  213. freely. It is not limited to 'S:TheChoice.config' anymore.
  214.  
  215. The Contents of the config file breaks down as follows :
  216.  
  217.   <Name of Program 1>
  218.   <executable script for Program 1>
  219.   <Name of Program 2>
  220.   <executable script for Program 2>
  221.   <Name of Program 3>
  222.   <executable script for Program 3>
  223.   .
  224.   .
  225.   .
  226.   .
  227.   <Name of Program xxx>
  228.   <executable script for Program xxx>
  229.  
  230. The <Name of Program> Text appears in the Gadget and the <executable script for
  231. Program> will be executed after selection of the appropiate gadget.
  232.  
  233. That's basically all you have to know (Quite simply, eh).
  234.  
  235. New in 2.10: When the executable script entry has the form
  236.  
  237.   "CONFIG=<name of the new configfile>"
  238.  
  239. the new configfile will be read in and the display changes to the new setup.
  240. This feature allows the user to create menu trees.
  241.  
  242.  
  243. THANKS TO
  244. =========
  245.  
  246.   - Christoph Stoppe for encouraging me to develop this little program further.
  247.  
  248.  
  249. WHAT CAN YOU DO
  250. ===============
  251.  
  252. If you have any proposals or find any bugs then let me know. I would also like
  253. to hear some opinions about this little program so that I can see if there is a
  254. need in the Amiga World for it or if I should waste my time on something other.
  255.  
  256.  
  257. HISTORY
  258. =======
  259.  
  260. 2.20 - 09.09.1996 - Fifth AmiNet Release
  261.      - Added Joystick and Keyboard control (Joystick control requires
  262.        'lowlevel.library' >= V40)
  263.      - Added the CLOSEQUIET option
  264.  
  265. 2.13 - 21.01.1996 - Fourth AmiNet Release
  266.      - Bugfix: TheChoice crashed if a new configfile could not be read in for
  267.        some reason
  268.  
  269. 2.12 - 20.01.1996 - Third AmiNet Release
  270.      - Renamed the RAMSCRIPT Tooltype and shell argument to SCRIPT
  271.      - some more code optimization resulting in the executable beeing about
  272.        7K (!) smaller
  273.      - TheChoice now returns errorcodes to the calling environment
  274.  
  275. 2.11 - 16.01.1996 - internal beta version
  276.      - some code optimization resulting in the executable being 150 bytes
  277.        smaller
  278.  
  279. 2.10 - 16.01.1996 - internal beta version
  280.      - compiled with SAS-C V6.56
  281.      - some code cleanup
  282.      - added the possibility to read in a new config file
  283.  
  284. 2.00 - 14.10.1995 - Second AmiNet Release
  285.      - Completly rewritten in SAS-C V6.55
  286.      - Runs on any screenmode using any font.
  287.      - The maximum number of programs / gadgets now depends on the chosen screen
  288.        mode and font.
  289.      - Can be configured using shell arguments or tooltypes.
  290.      - Supports borderless windows and onebitplane screens.
  291.      - No source code made publically available anymore.
  292.  
  293. 1.05 - 27.07.1995 - First AmiNet Release
  294.      - Removed some beta code so the executable is now a bit shorter
  295.      - Removed the switch between PAL and NTSC because NTSC is not supported in
  296.        this release
  297.      - TheChoice excutes the script again (due to some complaints by a friend of
  298.        mine
  299.  
  300. 1.04 - still beta, but several bug fixes and improvements...
  301.      - only PAL screen possible -> more max entries possible
  302.      - TheChoice now searches for the config script in S: rather than in Games:S
  303.      - TheChoice now copies the choosen script to the file "RAM:Script" which
  304.        you have to execute after you started TheChoice
  305.  
  306. 1.02-
  307. 1.03 - internal beta versions
  308.  
  309. 1.01 - 13.03.1994 - Bugfixed Release
  310.      - TheChoice crashed if the Config-File had more than 77 Programs
  311.  
  312. 1.0  - 23.11.1993 - First Release
  313.  
  314.  
  315. POSSIBLE FUTURE IMPROVEMENTS
  316. ============================
  317.  
  318.  - Use different pages so you can choose between more programs even on small
  319.    screens.
  320.  
  321. So long, tramps like us...
  322.  
  323.